home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIAccessibleDocument.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  4.6 KB  |  136 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 2002
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Original Author: Aaron Leventhal (aaronl@netscape.com)
  23.  * Contributor(s): John Gaunt (jgaunt@netscape.com)
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #include "nsISupports.idl"
  40.  
  41. interface nsIAccessible;
  42. interface nsIAccessNode;
  43. interface nsIDOMDocument;
  44. interface nsIDOMNode;
  45. interface nsIDOMWindow;
  46.  
  47. /**
  48.  * An interface for in-process accessibility clients
  49.  * that wish to retrieve information about a document.
  50.  * When accessibility is turned on in Gecko,
  51.  * there is an nsIAccessibleDocument for each document
  52.  * whether it is XUL, HTML or whatever.
  53.  * You can QueryInterface to nsIAccessibleDocument from
  54.  * the nsIAccessible or nsIAccessNode for the root node
  55.  * of a document. You can also get one from 
  56.  * nsIAccessNode::GetAccessibleDocument() or 
  57.  * nsIAccessibleEvent::GetAccessibleDocument()
  58.  *
  59.  * @status UNDER_REVIEW
  60.  */
  61. [scriptable, uuid(8781FC88-355F-4439-881F-6504A0A1CEB6)]
  62. interface nsIAccessibleDocument : nsISupports
  63. {
  64.   /**
  65.    * The URL of the document
  66.    */
  67.   readonly attribute AString URL;
  68.  
  69.   /**
  70.    * The title of the document, as specified in the document.
  71.    */
  72.   readonly attribute AString title;
  73.  
  74.   /**
  75.    * The mime type of the document
  76.    */
  77.   readonly attribute AString mimeType;
  78.  
  79.   /**
  80.    * The doc type of the document, as specified in the document.
  81.    */
  82.   readonly attribute AString docType;
  83.  
  84.   /**
  85.    * True if the document is live in an editor.
  86.    * False if the document is being displayed but not edited. 
  87.    * If a <div> is contentEditable, then it has its own document, 
  88.    * with isEditable == true.
  89.    */
  90.   readonly attribute boolean isEditable;
  91.  
  92.   /**
  93.    * The nsIDOMDocument interface associated with this document.
  94.    */
  95.   readonly attribute nsIDOMDocument document;
  96.  
  97.   /**
  98.    * The nsIDOMWindow that the document resides in.
  99.    */
  100.   readonly attribute nsIDOMWindow window;
  101.  
  102.   /*
  103.    * The accessible for the caret belonging to this window.
  104.    */
  105.   readonly attribute nsIAccessible caretAccessible;
  106.  
  107.   /**
  108.    * The namespace for each ID that is handed back.
  109.    */
  110.   AString getNameSpaceURIForID(in short nameSpaceID);
  111.  
  112.   /**
  113.    * The window handle for the OS window the document is being displayed in.
  114.    * For example, in Windows you can static cast it to an HWND.
  115.    */
  116.   [noscript] readonly attribute voidPtr windowHandle;
  117.  
  118.   /**
  119.    * Returns the access node cached by this document
  120.    * @param aUniqueID The unique ID used to cache the node.
  121.    *                  This matches up with the uniqueID attribute on
  122.    *                  nsIAccessNode.
  123.    * @return The nsIAccessNode cached for this particular unique ID.
  124.    */
  125.   [noscript] nsIAccessNode getCachedAccessNode(in voidPtr aUniqueID);
  126.  
  127.   /**
  128.    * Returns the first accessible parent of a DOM node.
  129.    * Guaranteed not to return nsnull if the DOM node is in a document.
  130.    * @param aDOMNode The DOM node we need an accessible for.
  131.    * @return An first nsIAccessible found by crawling up the DOM node
  132.    *         to the document root.
  133.    */
  134.   nsIAccessible getAccessibleInParentChain(in nsIDOMNode aDOMNode);
  135. };
  136.